Red Envelopes 红包
你可以请求一个 red_envelope 红包对象向你的用户发红包。所有和红包支付相关的要素信息都存储在 red_envelope 对象之中,你可以通过发起红包请求创建新的 red_envelope 对象,也可以随时查看红包对象的状态。每个 red_envelope 对象都拥有一个标识 id,该 id 在系统内唯一。
| 属性 | 描述 | 
|---|
| id string | 红包对象 id,由 Ping++ 生成,28 位长度字符串。 | 
| object string | 值为 red_envelope。 | 
| created timestamp | 支付红包的时间,用 Unix 时间戳表示。 | 
| received timestamp | 红包的接收时间,用 Unix 时间戳表示。 | 
| refunded timestamp | 红包超过 24 小时未领取的退回时间,用 Unix 时间戳表示。 | 
| livemode boolean | 支付是否处于 live模式。 | 
| status string | 红包状态。目前支持 6 种状态: sending: 发放中;sent: 已发放待领取;failed: 发放失败;received: 已领取;refunding: 退款中;refund: 已退款。 | 
| app expandable string | 红包使用的 app对象的id,expandable可展开,查看如何获取App ID。 | 
| channel string | 红包使用的第三方支付渠道。目前仅支持 wx_pub。 | 
| order_no string | 红包使用的商户订单号。 wx_pub渠道规定为 1 ~ 28 位不能重复的数字。 | 
| transaction_no string | 第三方支付渠道的交易流水号。 | 
| amount int | 红包金额。单位为对应币种的最小货币单位,例如:人民币为分。微信红包常规限额在 100 ~ 20000 之间, 即 1~200 元。如有需要,可前往微信商户平台进行设置和申请红包限额调整。 | 
| amount_settle int | 清算金额,单位为对应币种的最小货币单位,例如:人民币为分。 | 
| currency string | 三位 ISO 货币代码,目前仅支持人民币 cny。 | 
| recipient string | 接收者 id, 为用户在 wx_pub渠道下的open_id。 | 
| subject string | 红包主题名称,最多 32 个字节。 | 
| body string | 红包祝福语,最多 128 个字节。 | 
| description string | 备注信息,最多 255 个字节。 | 
| metadata hash | 参考元数据。 | 
| failure_msg string | 红包订单的错误消息的描述。 | 
| extra hash | 支付渠道相关的附加参数,具体参考下表 extra参数说明。 | 
| extra 参数 | 描述 | 
|---|
| send_name string | 商户名称,最多 32 个字节。 | 
| scene_id string | 发放红包使用场景,红包金额小于 1 元或大于 200 元时必传。具体属性请看请求参数中的 scene_id属性值。 | 
示例对象
{
   "id": "red_KCabLO58W5G0rX90iT0az5a9",
   "object": "red_envelope",
   "created": 1428499439,
   "received": null,
   "refunded": null,
   "livemode": true,
   "status": "sending",
   "app": "app_1Gqj58ynP0mHeX1q",
   "channel": "wx_pub",
   "order_no": "123456789",
   "transaction_no": null,
   "amount": 100,
   "amount_settle": 100,
   "currency": "cny",
   "recipient": "Openid",
   "subject": "Your Subject",
   "body": "Your Body",
   "description": "Your Description",
   "failure_msg":null,
   "extra": {
       "send_name": "Send Name"
   }
 }